feat: Set right UE version to CondaPackages parameter #196

alf-devnull · 2025-08-30T22:00:56Z

What was the problem/requirement? (What/Why)

It's necessary that CondaPackages parameter should contain same UE version as the version of the project from job is submitted. Therefore the default value define in Template should be updated on submit if its differs

What was the solution? (How)

Add validation of CondaPackages parameter.

If CondaPackages parameter not in OpenJob parameters - skip validation.
Otherwise check if its value contains unrealengine=x.x (Regex)
- If contains compare with current UE version of the Project
  - If equals, continue submit. Raise an Error otherwise
- If its not there, build with current version

What is the impact of this change?

Job can't be submitted with wrong unreal engine conda package version

How was this change tested?

Submit Job without CondaPackages parameter - validation skipped
With empty CondaPackages parameter - unrealengine=x.x were added (5.4)
With CondaPackages=unrealengine=5.3 - raise an error (Project was on 5.4)
With CondaPackages=unrealengine=5.4 - validation passed (Project was on 5.4)

Have you run the unit tests?
Yes

Have you run a render job successfully with these changes?

Yes

Was this change documented?

Yes

Is this a breaking change?

No

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py

Cherie-Chen · 2025-09-02T22:34:08Z

Thank you for looking into this. This feature will be extremely helpful for our users.

Proposed workflow for this feature:

Auto-Detection: Automatically detect user's current UE version
Version Handling:
- Override 'CondaPackages' default UE version with user's current version
- Display a warning popup if submission target version differs from current version
- Allow users to submit jobs with mismatched UE versions if they choose to proceed

This will provide maximum flexibility while maintaining proper warnings for users.

Cherie-Chen · 2025-09-03T16:01:38Z

Formatting issue detected in unreal_open_job.py by code scanning tool.

To resolve:

View issues: Run hatch run lint
Auto-fix formatting: Run hatch run fmt

Cherie-Chen · 2025-09-03T17:34:30Z

Hey, I've noticed something odd with the UE version detection. I'm running UE 5.5 (though I have 5.4 and 5.6 installed too), but the CondaPackages parameter is still showing 5.6. Oddly enough, I'm not seeing any validation warnings either, which is strange because I definitely got validation errors in the previous revision.

Could you please take a look again?

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py

src/deadline/unreal_submitter/exceptions.py

alf-devnull · 2025-09-04T09:26:38Z

Hey, I've noticed something odd with the UE version detection. I'm running UE 5.5 (though I have 5.4 and 5.6 installed too), but the CondaPackages parameter is still showing 5.6. Oddly enough, I'm not seeing any validation warnings either, which is strange because I definitely got validation errors in the previous revision.

Could you please take a look again?

Regarding the appearance of 5.6: This value always taken from YAML template and we don't overwrite its content since its our source of truth. But that really strange that there were no warnings.

I've got a question: which UE version resulted job has: 5.6 or 5.5?

Cherie-Chen · 2025-09-05T00:47:22Z

This value always taken from YAML template and we don't overwrite its content since its our source of truth.

Setting a default value for the CondaPackages parameter in unrealengine was implemented as a temporary solution to enable SMF support. We should enhance user experience by automatically detecting and populating the Unreal Engine version that the user is currently working with.

We still need to keep the default value for script-based job submissions, as it will be used when jobs are submitted programmatically.

BTW, pop-up warning dialog is working as expected in UE5.5 and UE5.6.

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py

Cherie-Chen · 2025-09-19T17:58:29Z

Small change request.

When submitting a job with mis-matched UE version, we first popup a warning asking user if they want to continue. When user click "No", we pop up another error. Please remove the 2nd pop up of error.

Screen.Recording.2025-09-19.at.10.54.24.AM.mov

Cherie-Chen · 2025-09-19T18:32:46Z

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py

+                unreal.AppReturnType.YES,
+            )
+
+            if result != unreal.AppReturnType.YES:


Same feed back as the video recording above. No need to raise error here.

After following the code, I can see why you wanted to throw an exception here now. The alternative is handling this in multiple places along the code path. I agree throwing an error here is the easier solution, please put that code back, I apologize for the bad suggestion. However, could you please rename the exception from InvalidUEVersionInCondaPackageParameterNoUI to UserCancelledSubmission_MissmatchedUEVersion to better reflect that this is a user-initiated cancellation due to UE version mismatch? This name better communicates the actual scenario being handled.

Cherie-Chen · 2025-10-02T00:16:50Z

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py

+                raise exceptions.InvalidUEVersionInCondaPackageParameterNoUI(
+                    "CondaPackages Unreal Engine version mismatch"
+                )


I suggest modifying the check_conda_package_version function to return a boolean value. This would make the logic more straightforward:

Return true to continue job submission

Return false to stop the process

This approach would make the code more readable and easier to maintain.

Signed-off-by: Ilona Alekseeva <[email protected]>

Signed-off-by: e.chernyakov <[email protected]>

…g is dismissed Signed-off-by: e.chernyakov <[email protected]>

Signed-off-by: e.chernyakov <[email protected]>

sonarqubecloud · 2025-10-17T10:09:38Z

Quality Gate passed

Issues
7 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Cherie-Chen · 2025-10-17T18:10:55Z

src/deadline/unreal_submitter/exceptions.py

+    pass
+
+
+class UserCancelledSubmissionMissMatchedUEVersion(DeadlineCloudSubmitterException, UserException):


Spelling issue. MissMatched -> Mismatched

alf-devnull requested a review from a team as a code owner August 30, 2025 22:00

alf-devnull changed the title ~~Feat: Set right UE version to CondaPackages parameter~~ feat: Set right UE version to CondaPackages parameter Aug 30, 2025

Cherie-Chen requested changes Sep 2, 2025

View reviewed changes

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py Outdated Show resolved Hide resolved

Cherie-Chen reviewed Sep 2, 2025

View reviewed changes

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py Outdated Show resolved Hide resolved

alf-devnull force-pushed the feature/check-ue-version branch from 5e34b9d to 89b5bbe Compare September 3, 2025 12:30

Cherie-Chen reviewed Sep 3, 2025

View reviewed changes

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py Outdated Show resolved Hide resolved

src/deadline/unreal_submitter/exceptions.py Outdated Show resolved Hide resolved

Cherie-Chen closed this Sep 5, 2025

Cherie-Chen reopened this Sep 5, 2025

github-actions bot added the waiting-on-maintainers Waiting on the maintainers to review. label Sep 5, 2025

karthikbekalp reviewed Sep 5, 2025

View reviewed changes

src/deadline/unreal_submitter/unreal_open_job/unreal_open_job.py Show resolved Hide resolved

alf-devnull force-pushed the feature/check-ue-version branch from 3d91b08 to 43f628a Compare September 12, 2025 12:04

Cherie-Chen reviewed Sep 19, 2025

View reviewed changes

Cherie-Chen reviewed Oct 2, 2025

View reviewed changes

alf-devnull force-pushed the feature/check-ue-version branch from 67a43c0 to dbd119e Compare October 2, 2025 07:51

Ilona Alekseeva and others added 10 commits October 16, 2025 10:11

add check conda package version

0ed9cce

Signed-off-by: Ilona Alekseeva <[email protected]>

add tests

5ea6060

Signed-off-by: Ilona Alekseeva <[email protected]>

fix: move ue version check to UnrealOpenJob

aed57d3

Signed-off-by: e.chernyakov <[email protected]>

fix: sonar cube issues

d844f17

Signed-off-by: e.chernyakov <[email protected]>

fix: Add EditorDialog on Version Mismatch

a2d44e8

Signed-off-by: e.chernyakov <[email protected]>

fix: resolve formatting issues

68faceb

Signed-off-by: e.chernyakov <[email protected]>

fix: rework ue version check conditions

a9a607a

Signed-off-by: e.chernyakov <[email protected]>

fix: add dialog default return value for unattended ue mode

ecb0722

Signed-off-by: e.chernyakov <[email protected]>

feat: add update ue package version in Mrq window

699ac06

Signed-off-by: e.chernyakov <[email protected]>

fix: Suppress error message after the “Conda packages mismatch” dialo…

59ea5e5

…g is dismissed Signed-off-by: e.chernyakov <[email protected]>

e.chernyakov added 2 commits October 16, 2025 10:13

fix: update check_conda_package_version to return boolean

a86e099

Signed-off-by: e.chernyakov <[email protected]>

fix: rename exceptions

41a9316

Signed-off-by: e.chernyakov <[email protected]>

Cherie-Chen removed the waiting-on-maintainers Waiting on the maintainers to review. label Oct 16, 2025

alf-devnull force-pushed the feature/check-ue-version branch from dbd119e to 41a9316 Compare October 17, 2025 10:09

Cherie-Chen reviewed Oct 17, 2025

View reviewed changes

		pass


		class UserCancelledSubmissionMissMatchedUEVersion(DeadlineCloudSubmitterException, UserException):

feat: Set right UE version to CondaPackages parameter #196

Are you sure you want to change the base?

feat: Set right UE version to CondaPackages parameter #196

Uh oh!

Conversation

alf-devnull commented Aug 30, 2025

What was the problem/requirement? (What/Why)

What was the solution? (How)

What is the impact of this change?

How was this change tested?

Have you run a render job successfully with these changes?

Was this change documented?

Is this a breaking change?

No

Uh oh!

Uh oh!

Uh oh!

Cherie-Chen commented Sep 2, 2025

Uh oh!

Cherie-Chen commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Cherie-Chen commented Sep 3, 2025

Uh oh!

Uh oh!

Uh oh!

alf-devnull commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Cherie-Chen commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Cherie-Chen commented Sep 19, 2025

Uh oh!

Cherie-Chen Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Cherie-Chen Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Cherie-Chen Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

alf-devnull Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Oct 17, 2025

Quality Gate passed

Uh oh!

Cherie-Chen Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Cherie-Chen commented Sep 3, 2025 •

edited

Loading

alf-devnull commented Sep 4, 2025 •

edited

Loading

Cherie-Chen commented Sep 5, 2025 •

edited

Loading

Cherie-Chen Sep 19, 2025 •

edited

Loading